home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / unixSyscall / RCS / stat.man,v < prev    next >
Text File  |  1988-12-31  |  6KB  |  272 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     88.12.31.11.56.26;  author ouster;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     88.12.31.11.44.11;  author ouster;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @@
  22.  
  23.  
  24. 1.2
  25. log
  26. @Document Sprite extensions.
  27. @
  28. text
  29. @.\" Copyright (c) 1980 Regents of the University of California.
  30. .\" All rights reserved.  The Berkeley software License Agreement
  31. .\" specifies the terms and conditions for redistribution.
  32. .\"
  33. .\"    @@(#)stat.2    6.7 (Berkeley) 10/25/87
  34. .\"
  35. .TH STAT 2 "October 25, 1987"
  36. .UC 4
  37. .SH NAME
  38. stat, lstat, fstat \- get file status
  39. .SH SYNOPSIS
  40. .nf
  41. .ft B
  42. #include <sys/types.h>
  43. #include <sys/stat.h>
  44. .PP
  45. .ft B
  46. stat(path, buf)
  47. char *path;
  48. struct stat *buf;
  49. .PP
  50. .ft B
  51. lstat(path, buf)
  52. char *path;
  53. struct stat *buf;
  54. .PP
  55. .ft B
  56. fstat(fd, buf)
  57. int fd;
  58. struct stat *buf;
  59. .fi
  60. .ft R
  61. .SH DESCRIPTION
  62. .I Stat
  63. obtains information about the file
  64. .IR path .
  65. Read, write or execute
  66. permission of the named file is not required, but all directories
  67. listed in the path name leading to the file must be reachable.
  68. .PP
  69. .I Lstat
  70. is like \fIstat\fP except in the case where the named file is a symbolic link,
  71. in which case
  72. .I lstat
  73. returns information about the link,
  74. while
  75. .I stat
  76. returns information about the file the link references.
  77. .PP
  78. .I Fstat
  79. obtains the same information about an open file
  80. referenced by the argument descriptor, such as would
  81. be obtained by an \fIopen\fP call.
  82. .PP
  83. .I Buf
  84. is a pointer to a
  85. .I stat
  86. structure into which information is placed concerning the file.
  87. The contents of the structure pointed to by
  88. .I buf
  89. .PP
  90. .nf
  91. .ta 1i 1.7i 3.0i
  92.      struct stat {
  93.     dev_t    st_dev;    /* device inode resides on */
  94.     ino_t    st_ino;    /* this inode's number */
  95.     u_short    st_mode;    /* protection */
  96.     short    st_nlink;    /* number or hard links to the file */
  97.     uid_t    st_uid;    /* user-id of owner */
  98.     gid_t    st_gid;    /* group-id of owner */
  99.     dev_t    st_rdev;    /* the device type, for inode that is device */
  100.     off_t    st_size;    /* total size of file */
  101.     time_t    st_atime;    /* file last access time */
  102.     int    st_spare1;
  103.     time_t    st_mtime;    /* file last modify time */
  104.     int    st_spare2;
  105.     time_t    st_ctime;    /* file last status change time */
  106.     int    st_spare3;
  107.     long    st_blksize;    /* optimal blocksize for file system i/o ops */
  108.     long    st_blocks;    /* actual number of blocks allocated */
  109.     long    st_serverID;    /* Sprite ID of server holding inode */
  110.     long    st_version;    /* Version number for file */
  111.     long    st_userType;    /* User-settable attribute word */
  112.     long    st_devServerID;    /* For devices, Sprite ID of device's machine */
  113.     };
  114. .fi
  115. .DT
  116. .PP
  117. .TP 12
  118. st_atime
  119. Time when file data was last accessed.  Changed by the following system
  120. calls:
  121. .IR mknod (2),
  122. .IR utimes (2),
  123. and
  124. .IR read (2).
  125. For directories, the access time is changed each time a file name
  126. lookup passes through the directory.
  127. .TP 12
  128. st_mtime
  129. Time when data was last modified.
  130. It is not set by changes of owner, group, link count, or mode.
  131. Changed by the following system calls:
  132. .IR mknod (2),
  133. .IR utimes (2),
  134. .IR write (2).
  135. .TP 12
  136. st_ctime
  137. Time when file status was last changed.
  138. It is set both both by writing and changing the i-node.
  139. Changed by the following system calls:
  140. .IR chmod (2)
  141. .IR chown (2),
  142. .IR link (2),
  143. .IR mknod (2),
  144. .IR rename (2),
  145. .IR unlink (2),
  146. .IR utimes (2),
  147. .IR write (2).
  148. .TP 12
  149. st_version
  150. Version number for the file.  It is incremented each time the file
  151. is opened for writing.
  152. .PP
  153. The status information word \fIst_mode\fP has bits:
  154. .nf
  155. .in +5n
  156. .ta 1.6i 2.5i 3i
  157. #define S_IFMT    0170000    /* type of file */
  158. #define\ \ \ \ S_IFDIR    0040000    /* directory */
  159. #define\ \ \ \ S_IFCHR    0020000    /* character special */
  160. #define\ \ \ \ S_IFBLK    0060000    /* block special */
  161. #define\ \ \ \ S_IFREG    0100000    /* regular */
  162. #define\ \ \ \ S_IFLNK    0120000    /* symbolic link */
  163. #define\ \ \ \ S_IFSOCK    0140000    /* socket */
  164. #define\ \ \ \ S_IFPDEV    0150000    /* pseudo-device */
  165. #define\ \ \ \ S_IFRLNK    0160000    /* remote link */
  166. #define S_ISUID    0004000    /* set user id on execution */
  167. #define S_ISGID    0002000    /* set group id on execution */
  168. #define S_IREAD    0000400    /* read permission, owner */
  169. #define S_IWRITE    0000200    /* write permission, owner */
  170. #define S_IEXEC    0000100    /* execute/search permission, owner */
  171. .fi
  172. .in -5n
  173. .PP
  174. The mode bits 0000070 and 0000007 encode group and
  175. others permissions (see
  176. .IR chmod (2)).
  177. .SH "RETURN VALUE
  178. Upon successful completion a value of 0 is returned.
  179. Otherwise, a value of \-1 is returned and
  180. .I errno
  181. is set to indicate the error.
  182. .SH "ERRORS
  183. .I Stat
  184. and
  185. .I lstat
  186. will fail if one or more of the following are true:
  187. .TP 15
  188. [ENOTDIR]
  189. A component of the path prefix is not a directory.
  190. .TP 15
  191. [EINVAL]
  192. The pathname contains a character with the high-order bit set.
  193. .TP 15
  194. [ENAMETOOLONG]
  195. A component of a pathname exceeded 255 characters,
  196. or an entire path name exceeded 1023 characters.
  197. .TP 15
  198. [ENOENT]
  199. The named file does not exist.
  200. .TP 15
  201. [EACCES]
  202. Search permission is denied for a component of the path prefix.
  203. .TP 15
  204. [ELOOP]
  205. Too many symbolic links were encountered in translating the pathname.
  206. .TP 15
  207. [EFAULT]
  208. .I Buf
  209. or
  210. .I name
  211. points to an invalid address.
  212. .TP 15
  213. [EIO]
  214. An I/O error occurred while reading from or writing to the file system.
  215. .PP
  216. .I Fstat
  217. will fail if one or both of the following are true:
  218. .TP 15
  219. [EBADF]
  220. .I Fildes
  221. is not a valid open file descriptor.
  222. .TP 15
  223. [EFAULT]
  224. .I Buf
  225. points to an invalid address.
  226. .TP 15
  227. [EIO]
  228. An I/O error occurred while reading from or writing to the file system.
  229. .SH CAVEAT
  230. The fields in the stat structure currently marked 
  231. .IR st_spare1 ,
  232. .IR st_spare2 ,
  233. and
  234. .I st_spare3
  235. are present in preparation for inode time stamps expanding
  236. to 64 bits.  This, however, can break certain programs that
  237. depend on the time stamps being contiguous (in calls to
  238. .IR utimes (2)).
  239. .SH "SEE ALSO"
  240. chmod(2), chown(2), utimes(2)
  241. .SH BUGS
  242. Applying
  243. .I fstat
  244. to a socket (and thus to a pipe)
  245. returns a zero'd buffer,
  246. except for the blocksize field,
  247. and a unique device and inode number.
  248. @
  249.  
  250.  
  251. 1.1
  252. log
  253. @Initial revision
  254. @
  255. text
  256. @d63 1
  257. a63 1
  258. .ta 1i 1.7i 2.5i
  259. d81 4
  260. a84 1
  261.     long    st_spare4[2];
  262. d97 2
  263. a98 3
  264. For reasons of efficiency, 
  265. st_atime is not set when a directory
  266. is searched, although this would be more logical.
  267. d120 4
  268. d136 2
  269. a139 1
  270. #define S_ISVTX    0001000    /* save swapped text even after use */
  271. @
  272.